API

Finance APIs

GET finance/sales-posting-adjustments/{salesPostingAdjustmentId}

Sales posting adjustment details for provided identifier

HTTP method GET
URI https://api.rambase.net/finance/sales-posting-adjustments/{salesPostingAdjustmentId}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {salesPostingAdjustmentId} Sales posting adjustment identifier
Integer, minimum 100000
Successful HTTP status code 200
API resource identifier 607, version 11

The following body must be added to the request. Mouse over fieldnames for description and other useful information about the fields. Note that fields in bold are required/mandatory.

Format:
1
1

The query string is placed after the resource URL, seperated with a questionmark (?). The query string is composed of a series of query parameters with values. See the page about query parameters on how to use these parameters.

$showDomainDescriptions Boolean, optional Set to "true" to include domain descriptions for fields using domain values. See the Domain values page for more information. Default value is false.
$lang String, optional Specifies the language used in the response, following the 3-letter ISO-639-1 [lll]
$access_token String, optional After successful login you get an access token which needs to be provided in all API requests. Even though it is possible to pass this token as query parameter, we recommended passing it using the HTTP request header as described in Authorization. Note that all access tokens have an expiration time.
$db String, optional Set the database/company for the request
$format String, optional Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json"
$useMinimumVersion Integer, optional Used to run a new version of an API resource when your API client is running a deprecated API resource. See the Breaking changes page for more information.
$select String, optional Use to define the fields to return in the response. Accepts a comma-separated list of field names. See the Expand and select page for more information.
$expand String, optional Use to include output fields that are not returned by default in the response. Accepts a comma-separated list of expandable field names. See the Expand and Select page for more information.

Read more about filters and sorting on how to use filter parameters and named filters.

Read more about filters and sorting on how to use sortable parameters

Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields. Fields colored in grey is expandable fields.

Please note that some fields may be removed from the response, based on user roles/duties/permissions.

Format:
1
<SalesPostingAdjustment>
2
     <SalesPostingAdjustmentId
SalesPostingAdjustmentId

Sales posting adjustment identifier

>{Integer}</SalesPostingAdjustmentId>
3
     <Status
Status

Status of sales posting adjustment

>{Integer}</Status>
4
     <Type
Type

Type of sales posting adjustment

Possible domain values can be found here

>{String}</Type>
5
     <CreatedAt
CreatedAt

Date and time of creation

>{Datetime}</CreatedAt>
6
     <IssueDate
IssueDate

Date when the document was issued.

>{Date}</IssueDate>
7
     <RegistrationDate
RegistrationDate

Date of registration

>{Date}</RegistrationDate>
8
     <SellersReference
SellersReference

Sellers reference. The default value will be retrieved from the creator/employee of the sales order.

>{String}</SellersReference>
9
     <SellersReferenceNumber
SellersReferenceNumber

Sellers reference number.

>{String}</SellersReferenceNumber>
10
     <Currency
Currency

Three character code following the ISO 4217 standard

Possible domain values can be found here

>{String}</Currency>
11
     <LocationCountryCode
LocationCountryCode

Country code of the location. Inherits from the location.

>{String}</LocationCountryCode>
12
     <Location>
13
          <ShortName
ShortName

Unique abbreviation/short name of the location

>{String}</ShortName>
14
     </Location>
15
     <Assignee
Assignee

The user who has been assigned to work with this object.

>
16
          <UserId
UserId

User identifier

>{Integer}</UserId>
17
          <UserLink
UserLink

User reference

>{String}</UserLink>
18
     </Assignee>
19
     <Customer>
20
          <CustomerId
CustomerId

Customer identifier

>{Integer}</CustomerId>
21
          <Name
Name

Name of customer (name of company or surname/familyname/lastname of a person)

>{String}</Name>
22
          <Firstname
Firstname

Secondary name of a company or firstname of a person

>{String}</Firstname>
23
          <Sales>
24
               <SalesDistrict
SalesDistrict

A geographic district for which an individual salesperson or sales team holds responsibility

Possible domain values can be found here

>{String}</SalesDistrict>
25
               <MarketSegment
MarketSegment

Market segment of the customer

Possible domain values can be found here

>{String}</MarketSegment>
26
          </Sales>
27
          <CustomerGroup>
28
               <CustomerGroupId
CustomerGroupId

Customer legal entity identifier

>{Integer}</CustomerGroupId>
29
               <CustomerGroupLink
CustomerGroupLink

Reference to customer legal entity

>{String}</CustomerGroupLink>
30
          </CustomerGroup>
31
          <CustomerLink
CustomerLink

Customer reference

>{String}</CustomerLink>
32
     </Customer>
33
     <ShippingAddress>
34
          <AddressId
AddressId

Address identifier

>{Integer}</AddressId>
35
          <CountryCode
CountryCode

Two-character code (ISO 3166) identifying the country.

>{String}</CountryCode>
36
     </ShippingAddress>
37
     <Totals>
38
          <Currency
Currency

Three character code following the ISO 4217 standard

>{String}</Currency>
39
          <SubTotalAmount
SubTotalAmount

Total amount of the object in object currency, excluding VAT.

>{Decimal}</SubTotalAmount>
40
          <VATAmount
VATAmount

Total value added tax in object currency.

>{Decimal}</VATAmount>
41
          <TotalAmount
TotalAmount

The total amount in object currency, including VAT

>{Decimal}</TotalAmount>
42
     </Totals>
43
     <TotalsConverted
TotalsConverted

This field is greyed out because it is an expandable field. You have to add $expand=TotalsConverted in your request URI to get this field

>
44
          <Currency
Currency

Currency used in conversion. Default is company accounting currency. Three character code following the ISO 4217 standard.

This field is greyed out because it is an expandable field. You have to add $expand=TotalsConverted in your request URI to get this field

>{String}</Currency>
45
          <ExchangeRate
ExchangeRate

The exchange rate used in convertion

This field is greyed out because it is an expandable field. You have to add $expand=TotalsConverted in your request URI to get this field

>{Decimal}</ExchangeRate>
46
          <SubTotalAmount
SubTotalAmount

Total amount of the object in company currency, excluding VAT.

This field is greyed out because it is an expandable field. You have to add $expand=TotalsConverted in your request URI to get this field

>{Decimal}</SubTotalAmount>
47
          <VATAmount
VATAmount

Value added tax amount in company currency.

This field is greyed out because it is an expandable field. You have to add $expand=TotalsConverted in your request URI to get this field

>{Decimal}</VATAmount>
48
          <TotalAmount
TotalAmount

The total amount in company currency, including VAT.

This field is greyed out because it is an expandable field. You have to add $expand=TotalsConverted in your request URI to get this field

>{Decimal}</TotalAmount>
49
     </TotalsConverted>
50
     <VATDetails>
51
          <VATType
VATType

Type of value added tax

>{String}</VATType>
52
          <VATHandling
VATHandling

Specifies how value added tax (VAT) should be calculated. Either always include VAT, always exclude VAT or use standard/default VAT rules.

Possible domain values can be found here

>{String}</VATHandling>
53
          <DefaultVATPercent
DefaultVATPercent

Value added tax percent.

>{Decimal}</DefaultVATPercent>
54
     </VATDetails>
55
     <Accounting>
56
          <AccountingPeriod
AccountingPeriod

The accounting period the object belongs to

>{Integer}</AccountingPeriod>
57
          <ReceivableLedgerSpecification>
58
               <ReceivableLedgerSpecificationId
ReceivableLedgerSpecificationId

Sales posting adjustment identifier

>{Integer}</ReceivableLedgerSpecificationId>
59
               <ReceivableLedgerSpecificationLink
ReceivableLedgerSpecificationLink

Sales posting adjustment refernce

>{String}</ReceivableLedgerSpecificationLink>
60
          </ReceivableLedgerSpecification>
61
     </Accounting>
62
</SalesPostingAdjustment>
1
{
2
     "salesPostingAdjustment": {
3
          "salesPostingAdjustmentId
SalesPostingAdjustmentId

Sales posting adjustment identifier

": "{Integer}",
4
          "status
Status

Status of sales posting adjustment

": "{Integer}",
5
          "type
Type

Type of sales posting adjustment

Possible domain values can be found here

": "{String}",
6
          "createdAt
CreatedAt

Date and time of creation

": "{Datetime}",
7
          "issueDate
IssueDate

Date when the document was issued.

": "{Date}",
8
          "registrationDate
RegistrationDate

Date of registration

": "{Date}",
9
          "sellersReference
SellersReference

Sellers reference. The default value will be retrieved from the creator/employee of the sales order.

": "{String}",
10
          "sellersReferenceNumber
SellersReferenceNumber

Sellers reference number.

": "{String}",
11
          "currency
Currency

Three character code following the ISO 4217 standard

Possible domain values can be found here

": "{String}",
12
          "locationCountryCode
LocationCountryCode

Country code of the location. Inherits from the location.

": "{String}",
13
          "location": {
14
               "shortName
ShortName

Unique abbreviation/short name of the location

": "{String}"
15
          },
16
          "assignee
Assignee

The user who has been assigned to work with this object.

": {
17
               "userId
UserId

User identifier

": "{Integer}",
18
               "userLink
UserLink

User reference

": "{String}"
19
          },
20
          "customer": {
21
               "customerId
CustomerId

Customer identifier

": "{Integer}",
22
               "name
Name

Name of customer (name of company or surname/familyname/lastname of a person)

": "{String}",
23
               "firstname
Firstname

Secondary name of a company or firstname of a person

": "{String}",
24
               "sales": {
25
                    "salesDistrict
SalesDistrict

A geographic district for which an individual salesperson or sales team holds responsibility

Possible domain values can be found here

": "{String}",
26
                    "marketSegment
MarketSegment

Market segment of the customer

Possible domain values can be found here

": "{String}"
27
               },
28
               "customerGroup": {
29
                    "customerGroupId
CustomerGroupId

Customer legal entity identifier

": "{Integer}",
30
                    "customerGroupLink
CustomerGroupLink

Reference to customer legal entity

": "{String}"
31
               },
32
               "customerLink
CustomerLink

Customer reference

": "{String}"
33
          },
34
          "shippingAddress": {
35
               "addressId
AddressId

Address identifier

": "{Integer}",
36
               "countryCode
CountryCode

Two-character code (ISO 3166) identifying the country.

": "{String}"
37
          },
38
          "totals": {
39
               "currency
Currency

Three character code following the ISO 4217 standard

": "{String}",
40
               "subTotalAmount
SubTotalAmount

Total amount of the object in object currency, excluding VAT.

": "{Decimal}",
41
               "vATAmount
VATAmount

Total value added tax in object currency.

": "{Decimal}",
42
               "totalAmount
TotalAmount

The total amount in object currency, including VAT

": "{Decimal}"
43
          },
44
          "totalsConverted
TotalsConverted

This field is greyed out because it is an expandable field. You have to add $expand=TotalsConverted in your request URI to get this field

": {
45
               "currency
Currency

Currency used in conversion. Default is company accounting currency. Three character code following the ISO 4217 standard.

This field is greyed out because it is an expandable field. You have to add $expand=TotalsConverted in your request URI to get this field

": "{String}",
46
               "exchangeRate
ExchangeRate

The exchange rate used in convertion

This field is greyed out because it is an expandable field. You have to add $expand=TotalsConverted in your request URI to get this field

": "{Decimal}",
47
               "subTotalAmount
SubTotalAmount

Total amount of the object in company currency, excluding VAT.

This field is greyed out because it is an expandable field. You have to add $expand=TotalsConverted in your request URI to get this field

": "{Decimal}",
48
               "vATAmount
VATAmount

Value added tax amount in company currency.

This field is greyed out because it is an expandable field. You have to add $expand=TotalsConverted in your request URI to get this field

": "{Decimal}",
49
               "totalAmount
TotalAmount

The total amount in company currency, including VAT.

This field is greyed out because it is an expandable field. You have to add $expand=TotalsConverted in your request URI to get this field

": "{Decimal}"
50
          },
51
          "vATDetails": {
52
               "vATType
VATType

Type of value added tax

": "{String}",
53
               "vATHandling
VATHandling

Specifies how value added tax (VAT) should be calculated. Either always include VAT, always exclude VAT or use standard/default VAT rules.

Possible domain values can be found here

": "{String}",
54
               "defaultVATPercent
DefaultVATPercent

Value added tax percent.

": "{Decimal}"
55
          },
56
          "accounting": {
57
               "accountingPeriod
AccountingPeriod

The accounting period the object belongs to

": "{Integer}",
58
               "receivableLedgerSpecification": {
59
                    "receivableLedgerSpecificationId
ReceivableLedgerSpecificationId

Sales posting adjustment identifier

": "{Integer}",
60
                    "receivableLedgerSpecificationLink
ReceivableLedgerSpecificationLink

Sales posting adjustment refernce

": "{String}"
61
               }
62
          }
63
     }
64
}

List of available operations/actions for this resource.
See the operations documentation for more information about API operations.

Possible error codes the response might return:

Error 100051 HTTP 400 When logged in as supplier {0} you do not have access to this API resource
Error 100055 HTTP 403 You have only admittance to your own objects